Skip to content

Add Giscus comments system#267

Draft
fflaten wants to merge 5 commits intopester:mainfrom
fflaten:giscus
Draft

Add Giscus comments system#267
fflaten wants to merge 5 commits intopester:mainfrom
fflaten:giscus

Conversation

@fflaten
Copy link
Collaborator

@fflaten fflaten commented May 3, 2023 •
edited
Loading

Implements Giscus as comment system for all Docs and Commands-pages. Only index-page is currently excluded.
Comments are stored and managed as discussions in specific category in the docs-repo.

Fix #251

TODO:

  • Install Giscus app in docs-repo
  • Enable discussion in docs-repo. Remove default categories and create a "Comments" or "Website Comments"-category of Announcement-type
  • Update config
  • Reswizzle after Docusaurus v3 upgrade Docusaurus v3 #272

@bravo-kernel
Copy link
Collaborator

bravo-kernel commented May 4, 2023

Looks amazing. Perhaps comments could also be excluded for the Additional Resources section but to be honest, I think that whole section should either be dropped or totally reworked anyway. It's just a lot of very (years old) content for which a google search provides better results.

@fflaten
Copy link
Collaborator Author

fflaten commented May 4, 2023 •
edited
Loading

Great minds. See #264 😁
Until then, comments to help crowdsource what works or not is an improvement.

@fflaten fflaten changed the title Add Giscus comments to docs pages Add Giscus comments system May 5, 2023
@fflaten
Copy link
Collaborator Author

fflaten commented May 5, 2023

A few sample pages:

What do you think @nohwnd?

@bravo-kernel
Copy link
Collaborator

bravo-kernel commented May 16, 2023

LGTM shall we just merge this?

@fflaten
Copy link
Collaborator Author

fflaten commented May 16, 2023 •
edited
Loading

Can't, see task list in PR details. Using my fork's discussion atm. So waiting on approval and actions from @nohwnd 🙂

@bravo-kernel
Copy link
Collaborator

bravo-kernel commented May 16, 2023

Ahhh 🤦🏻

@fflaten
Copy link
Collaborator Author

fflaten commented Jun 15, 2024 •
edited
Loading

How should we handle docs version changes? E.g. when we move /docs/* from v5 to v6 in the future, the existing comments made in v5-lifetime will show up on v6-pages which might be rewritten.

Options:

  1. Is that okay? Comments can become out of date during minor upgrades and docs-upates either way.

2) Should we move to always use versioned URLs in #316 and rather redirect /docs/* to latest stable (/docs/v5/*)? That way canonical URIs used to link page -> discussion-issue always /v5, /v6 etc. Be aware, this would also show versioned URIs in Google search results

  1. Is it possible to get the version inside a Docusaurus component (Giscus.js) so we can build versioned backlink-URI?

fflaten
fflaten commented Jun 15, 2024
View reviewed changes
src/components/Giscus/Giscus.js

return (
<Head>
<meta name="giscus:backlink" content={canonicalUrl} />
Copy link
Collaborator Author

@fflaten fflaten Jun 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Always add version here? Maybe possible to get current page version dynamically through useDocusaurusContext() to avoid hardcoding replace /docs/ with /docs/v5 for stable like we do in _redirects ?

@fflaten fflaten mentioned this pull request Jun 17, 2024
Merged
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Giscus comments

2 participants

@fflaten @bravo-kernel